Groups

Simplify device management by organizing devices into groups.

End Points

GET

/api/v1/mdm/groups

POST

/api/v1/mdm/groups

GET

/api/v1/mdm/groups/{group_id}

DELETE

/api/v1/mdm/groups/{group_id}

GET

/api/v1/mdm/groups/{group_id}/members

POST

/api/v1/mdm/groups/{group_id}/members

POST

/api/v1/mdm/groups/{group_id}/members/{member_id}

DELETE

/api/v1/mdm/groups/{group_id}/members/{member_id}

POST

/api/v1/mdm/groups/{group_id}/apps

DELETE

/api/v1/mdm/groups/{group_id}/apps

POST

/api/v1/mdm/groups/{group_id}/profiles

DELETE

/api/v1/mdm/groups/{group_id}/profiles

PUT

/api/v1/mdm/groups/{group_id}/targetgroups

Attribute

group_id

long

Unique Identifier for the group

name

string

Name of the group

group_type

integer

Type of group:

Device Group

domain

string

Domain in which the group exists (if AD is synced)

[
    {
        "group_id": 99731238129,
        "name": "MDM",
        "group_type": 1,
        "domain": "ZOHOCORP"
    }
]

Get Group list

Get a list of Groups available in MDM
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/groups

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "groups": [
        {
            "group_id": 99731238129,
            "name": "MDM",
            "group_type": 1,
            "domain": "ZOHOCORP"
        }
    ]
}

Create a Group

Create a Group for managing devices
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/groups

Arguments

name

string

(Required)

Name of the group

group_type

integer

(Required)

Type of group:

Device Group

domain

string

Domain in which the group exists (if AD is synced)

description

string

Description of the group

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "name": "MDM",
    "group_type": 1,
    "domain": "ZOHOCORP",
    "description": "Group for MDM"
}

HTTP/1.1

{
    "group_id": 99731238129,
    "name": "MDM",
    "group_type": 1,
    "domain": "ZOHOCORP",
    "description": "Group for MDM"
}

Get Group details

Get details of a particular Group available in MDM
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/groups/{group_id}

Query Parameters

include

Types

To Include the members details use memberdetails
To Include the members IDs use member
To Include the group summary details use summary

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "group_id": 99731238129,
    "name": "MDM",
    "group_type": 1,
    "domain": "ZOHOCORP",
    "description": "Group for MDM"
}

Delete an existing Group

Delete a Group available in MDM
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/groups/{group_id}

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "group_id": 99731238129,
    "name": "MDM",
    "group_type": 1,
    "domain": "ZOHOCORP",
    "description": "Group for MDM"
}

Get members present in a Group

Get a list of members present in a particular Group
oauthscope : MDMOnDemand.MDMDeviceMgmt.READ

GET - /api/v1/mdm/groups/{group_id}/members

Query Parameters

include

Include the members details

memberdetails

curl --request GET \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/members \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

Add members to a Group

Add multiple members simultaneously to an existing Group
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/groups/{group_id}/members

Arguments

member_ids

array

(Required)

List of member IDs which may be either Device Ids or User Ids depands on the Group Type

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/members \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

HTTP/1.1

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

Add a member to a Group

Add a particular member to a selected Group
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/groups/{group_id}/members/{member_id}

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/members/987000000654321 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

Remove a member from a Group

Remove a member from a particular Group
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/groups/{group_id}/members/{member_id}

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/members/987000000654321 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

HTTP/1.1

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

Associate apps to a Group

Associate apps to a Group in MDM
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/groups/{group_id}/apps

Arguments

app_details

array

(Required)

The list of app with version details

Show Sub-Attributes

app_id

long

(Required)

The app Id

release_label_id

long

(Required)

ID to denote whether the app version is Stable or Beta (Example To create release lable id)

silent_install

boolean

Whether the app should be installed silently on devices

notify_user_via_email

boolean

Notify user via email about the distributed app

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/apps \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "app_details": [
        {
            "app_id": 12,
            "release_label_id": 123
        }
    ],
    "silent_install": true,
    "notify_user_via_email": true
}

HTTP/1.1

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

Disassociate apps from a Group

Disassociate apps from a Group in MDM
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/groups/{group_id}/apps

Arguments

app_ids

array

(Required)

List of app IDs

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/apps \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "app_ids": [
        1,
        2,
        3
    ]
}

HTTP/1.1

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

Associate profiles to a Group

Associate profiles to a Group in MDM
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

POST - /api/v1/mdm/groups/{group_id}/profiles

Arguments

profile_ids

array

(Required)

List of profile IDs for the profiles to be associated to the Group

curl --request POST \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/profiles \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "profile_ids": [
        1,
        2,
        3
    ]
}

HTTP/1.1

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

Disassociate profiles from a Group in MDM

Disassociate profiles from a Group in MDM
oauthscope : MDMOnDemand.MDMDeviceMgmt.DELETE

DELETE - /api/v1/mdm/groups/{group_id}/profiles

Arguments

profile_ids

array

(Required)

List of profile IDs for the profiles to be associated to the Group

curl --request DELETE \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/profiles \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "profile_ids": [
        1,
        2,
        3
    ]
}

HTTP/1.1

{
    "member_ids": [
        12,
        213123,
        21312
    ]
}

Move devices from one group to other groups

Move a set of member from one group to other Groups
oauthscope : MDMOnDemand.MDMDeviceMgmt.CREATE

PUT - /api/v1/mdm/groups/{group_id}/targetgroups

Arguments

member_ids

array

(Required)

List of member IDs which may be either Device Ids or User Ids depands on the Group Type

target_group_ids

array

(Required)

List of target group IDs

curl --request PUT \
  --url https://www.mdm.manageengine.com/api/v1/mdm/groups/99731238129/targetgroups \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "member_ids": [
        12,
        213123,
        21312
    ],
    "target_group_ids": [
        1,
        2,
        3
    ]
}

HTTP/1.1

{
    "success": true
}